<meta charset="utf-8">
(#) Valid Full Backup Content File

!!! ERROR: Valid Full Backup Content File
   This is an error, and is also enforced at build time when
   supported by the build system. For Android this means it will
   run during release builds.

Id
:   `FullBackupContent`
Summary
:   Valid Full Backup Content File
Severity
:   Fatal
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   1.3.0 (July 2015)
Affects
:   Resource files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://android-developers.googleblog.com/2015/07/auto-backup-for-apps-made-simple.html
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/FullBackupContentDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/FullBackupContentDetectorTest.kt)

Ensures that `<data-extraction-rules`> and `<full-backup-content>`
files, which configure backup options, are valid.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
res/xml/data_extraction_rules.xml:6:Error: foo.xml is not in an included
path [FullBackupContent]
    &lt;exclude domain="sharedpref" path="foo.xml"/&gt;
                                       -------
res/xml/full_backup_content.xml:5:Error: foo.xml is not in an included
path [FullBackupContent]
    &lt;exclude domain="sharedpref" path="foo.xml"/&gt;
                                       -------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`src/AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android" package="my.pkg" &gt;
    &lt;application
        android:fullBackupContent="@xml/full_backup_content"&gt;
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:label="@string/app_name"&gt;
        ...
    &lt;/application&gt;
&lt;/manifest&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`res/xml/data_extraction_rules.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;data-extraction-rules&gt;
    &lt;cloud-backup&gt;
        &lt;include domain="file" path="dd"/&gt;
        &lt;exclude domain="file" path="dd/fo3o.txt"/&gt;
        &lt;exclude domain="file" path="dd/ss/foo.txt"/&gt;
        &lt;exclude domain="sharedpref" path="foo.xml"/&gt;
    &lt;/cloud-backup&gt;
    &lt;device-transfer&gt;
        &lt;include domain="file"/&gt;
        &lt;exclude domain="file" path="dd/fo3o.txt"/&gt;
        &lt;include domain="sharedpref" path="something"/&gt;
    &lt;/device-transfer&gt;
&lt;/data-extraction-rules&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`res/xml/full_backup_content.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;full-backup-content&gt;
     &lt;include domain="file" path="dd"/&gt;
     &lt;exclude domain="file" path="dd/fo3o.txt"/&gt;
     &lt;exclude domain="file" path="dd/ss/foo.txt"/&gt;
     &lt;exclude domain="sharedpref" path="foo.xml"/&gt;
&lt;/full-backup-content&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/FullBackupContentDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Adding the suppression attribute `tools:ignore="FullBackupContent"`
  on the problematic XML element (or one of its enclosing elements).
  You may also need to add the following namespace declaration on the
  root element in the XML file if it's not already there:
  `xmlns:tools="http://schemas.android.com/tools"`.

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="FullBackupContent" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'FullBackupContent'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore FullBackupContent ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>